Add a doc comment for gsk_rounded_rect_is_circular
authorMatthias Clasen <mclasen@redhat.com>
Fri, 4 Jun 2021 12:44:37 +0000 (08:44 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 4 Jun 2021 13:49:05 +0000 (09:49 -0400)
gsk/gskroundedrect.c

index 81a5b96e61e8e9e2e95fcb38406761dc5f0a8773..42df2bf06c3e3912442496eb92062434e99b72ee 100644 (file)
@@ -310,7 +310,17 @@ gsk_rounded_rect_scale_affine (GskRoundedRect       *dest,
     }
 }
 
-/* XXX: Find a better name */
+/*<private>
+ * gsk_rounded_rect_is_circular:
+ * @self: the `GskRoundedRect` to check
+ *
+ * Checks if all corners of @self are quarter-circles (as
+ * opposed to quarter-ellipses).
+ *
+ * Note that different corners can still have different radii.
+ *
+ * Returns: %TRUE if the rectangle is circular.
+ */
 gboolean
 gsk_rounded_rect_is_circular (const GskRoundedRect *self)
 {